/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.autoconfigure.session;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.session.FlushMode;
import org.springframework.session.SaveMode;

/**
 * 基于 Redis 的 Spring Session 配置属性。
 *
 * @author Vedran Pavic
 * @since 2.0.0
 */
@ConfigurationProperties(prefix = "spring.session.redis")
public class RedisSessionProperties {

	private static final String DEFAULT_CLEANUP_CRON = "0 * * * * *";

	/**
	 * 用于存储会话的键命名空间。
	 */
	private String namespace = "spring:session";

	/**
	 * 会话刷新模式。决定何时将会话更改写入会话存储。
	 */
	private FlushMode flushMode = FlushMode.ON_SAVE;

	/**
	 * 会话保存模式。决定如何跟踪和保存会话更改到会话存储。
	 */
	private SaveMode saveMode = SaveMode.ON_SET_ATTRIBUTE;

	/**
	 * 当没有用户定义的 ConfigureRedisAction Bean 时应用的配置操作。
	 */
	private ConfigureAction configureAction = ConfigureAction.NOTIFY_KEYSPACE_EVENTS;

	/**
	 * 过期会话清理任务的 Cron 表达式。
	 */
	private String cleanupCron = DEFAULT_CLEANUP_CRON;

	public String getNamespace() {
		return this.namespace;
	}

	public void setNamespace(String namespace) {
		this.namespace = namespace;
	}

	public FlushMode getFlushMode() {
		return this.flushMode;
	}

	public void setFlushMode(FlushMode flushMode) {
		this.flushMode = flushMode;
	}

	public SaveMode getSaveMode() {
		return this.saveMode;
	}

	public void setSaveMode(SaveMode saveMode) {
		this.saveMode = saveMode;
	}

	public String getCleanupCron() {
		return this.cleanupCron;
	}

	public void setCleanupCron(String cleanupCron) {
		this.cleanupCron = cleanupCron;
	}

	public ConfigureAction getConfigureAction() {
		return this.configureAction;
	}

	public void setConfigureAction(ConfigureAction configureAction) {
		this.configureAction = configureAction;
	}

	/**
	 * 用于配置和验证 Redis 的策略枚举。
	 */
	public enum ConfigureAction {

		/**
		 * 确保启用 Redis Keyspace 事件，用于通用命令和过期事件。
		 */
		NOTIFY_KEYSPACE_EVENTS,

		/**
		 * 不尝试应用任何自定义的 Redis 配置。
		 */
		NONE

	}

}
